

===================================
==                               ==
==         LODE FUNNER           ==
==                               ==
==                               ==
==           by Disch            ==
==                               ==
===================================

   Lode Funner is a level editor for the NES version of Lode Runner.  Source code is included as public domain.  It uses wxWidgets for everything, I was careful about endian issues, and I did not use anything OS-specific... so it should be very portable.  If you feel like porting to other platforms are releasing, by all means.


   Using the editor is pretty self-explanitory.  There are a few things to know,
though, so opening this readme was a good move!  I'll present these things to
know in the form of a FAQ whynot.


-------------------------------------------------------------------------------

Q)  HALP!  I get missing DLL errors!

A)  Yeah I built with VS -- when you use libs like wxWidgets it likes to make you use additional runtime crap.  If you don't have these files you can find them on the web by searching for their filename.


-------------------------------------------------------------------------------

Q)  WTF is this "file offsets" window that pops up?

A)  Since space in the original ROM is extremely limited, it's so easily expandable, and since I'm using so few offsets, I figured the best way to make this editor would be to have no offsets hardcoded in the editor.  Rather than read offsets from an external file or something like that, I pop up that offsets window on startup.  Its default values will work with a normal, unmodified ROM.

If you do some in-depth work on the hack that requires things like palettes and whatever to be shifted around, offsets can be manipulated by hand via this window as well.

There are two presets buttons at the top.  "Original" will fill the fields with the
values used by the original ROM.  "Expanded" will fill the fields with expanded ROM values.

-------------------------------------------------------------------------------

Q)  WTF I get a "Maps cannot compress" error when I try to save and then it doesn't save!  What gives?

A)  There's not a lot of space given to maps in the original ROM.  The space your levels take up depends on how well they can compress.  Complex maps with lots of enemies will take up more bytes than simple maps with fewer enemies.

If you need more space, you can expand the ROM to 32K PRG.  This gives a lot more room for levels.  In fact, I don't even think it'd be possible to run out space for 50 levels in an expanded ROM.


-------------------------------------------------------------------------------

Q)  Okay, so how do I expand the ROM?

A)  The LodeFatter utility was included for this very reason.  Simply run it from the command prompt:

LodeFatter yourrom.nes

And it will create yourrom_expanded.nes.  Note this only works with LODE RUNNER ROMs.  Don't get cute and try to expand other games with this utility... it not only expands, but shifts around level data and adjusts pointers, so if you try it on another ROM, you'll just get a broken file.

-------------------------------------------------------------------------------

Q)  Command prompt?  ;_;

A)  Yeah, I generally don't like working with command line stuff either.  To make life easier on yourself, you can just drag your ROM onto LodeFatter.exe in Windows Explorer to get the job done.

-------------------------------------------------------------------------------

Q)  I tried double-clicking LodeFatter.exe and it just closes right away.

A)  Of course it does.  It's a command line program.  See above 2 Qs for how to use it.

-------------------------------------------------------------------------------

Q)  If expanding gives so much free space, is there any reason why I shouldn't expand my ROM?

A)  Kinda.  It's debatable.  The biggest drawback is that it will make your IPS a lot bigger.  But aside from that, no, it really doesn't hurt at all to have an expanded ROM.

-------------------------------------------------------------------------------

Q)  What is this "LevelsOffsets.cfg" file that keeps being created?

A)  Lode Funner remembers your offsets for the ROMs you edit (so you don't have to change your offsets every time you load the ROM).  The config file stores that information.


-------------------------------------------------------------------------------

Q)  I didn't expand my ROM, and I did all this work on my hack and now it won't let me save because it can't compress!  I don't want to have to lose all my work!  Help!

A)  You can export the level(s) you weren't able to save via the 'Levels' menu.  Then you an exit the editor, expand your ROM, then import the level(s) in your expanded ROM.

-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------

Random facts:


-  I don't think I ever played Lode Runner before I began looking for its level data.

-  I started looking at its level data only because some guy on some forum asked about it.  I thought it would be simple but it turned out to be pretty complicated!

-  I hate making editors

-  I made this editor because there's really no way to edit these levels by hand, given the format, and because I thought having an editor with the name "Lode Funner" would be hilarious.

-  The source is included and is public domain.

-  I probably will never touch this editor again.  Don't ask me for new features, but if something is horribly wrong (like some huge bug I missed), then you can bring it to my attention and I may fix it.

-  The editor will save only level data when you save the game -- it will not overwrite other things.  Therefore it is safe for you to edit the ROM with something else (like a tile or hex editor) simultaneously, and when you save in Lode Funner, it will not overwrite your graphics/whatever.  Note that the inverse is not true (saving in the tile/hex editor will likely overwrite your edited levels).
